<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SMTC Modem API: smtc_modem_utilities.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SMTC Modem API
   </div>
   <div id="projectbrief">Generic Modem API description</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">smtc_modem_utilities.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>modem utilities  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &quot;<a class="el" href="smtc__modem__api_8h_source.html">smtc_modem_api.h</a>&quot;</code><br />
<code>#include &quot;radio_planner.h&quot;</code><br />
<code>#include &quot;lr1mac_defs.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for smtc_modem_utilities.h:</div>
<div class="dyncontent">
<div class="center"><img src="smtc__modem__utilities_8h__incl.png" border="0" usemap="#asmtc__modem__utilities_8h" alt=""/></div>
<map name="asmtc__modem__utilities_8h" id="asmtc__modem__utilities_8h">
<area shape="rect" title="modem utilities" alt="" coords="124,5,302,32"/>
<area shape="rect" title=" " alt="" coords="11,155,82,181"/>
<area shape="rect" title=" " alt="" coords="112,155,194,181"/>
<area shape="rect" href="smtc__modem__api_8h.html" title="Generic Modem API description." alt="" coords="24,80,175,107"/>
<area shape="rect" title=" " alt="" coords="250,80,373,107"/>
<area shape="rect" title=" " alt="" coords="397,80,512,107"/>
</map>
</div>
</div>
<p><a href="smtc__modem__utilities_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa4f2505615389e15ac9f619e68f90a99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="smtc__modem__utilities_8h.html#aa4f2505615389e15ac9f619e68f90a99">smtc_modem_init</a> (void(*callback)(void))</td></tr>
<tr class="memdesc:aa4f2505615389e15ac9f619e68f90a99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init the soft modem and set the modem event chosen callback.  <a href="smtc__modem__utilities_8h.html#aa4f2505615389e15ac9f619e68f90a99">More...</a><br /></td></tr>
<tr class="separator:aa4f2505615389e15ac9f619e68f90a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae45f68af8fe65e4aa47dedbb5f5fd7e1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="smtc__modem__utilities_8h.html#ae45f68af8fe65e4aa47dedbb5f5fd7e1">smtc_modem_run_engine</a> (void)</td></tr>
<tr class="memdesc:ae45f68af8fe65e4aa47dedbb5f5fd7e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the modem engine.  <a href="smtc__modem__utilities_8h.html#ae45f68af8fe65e4aa47dedbb5f5fd7e1">More...</a><br /></td></tr>
<tr class="separator:ae45f68af8fe65e4aa47dedbb5f5fd7e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>modem utilities </p>
<p>Revised BSD License Copyright Semtech Corporation 2020. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p><ul>
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
<li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li>
<li>Neither the name of the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</li>
</ul>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aa4f2505615389e15ac9f619e68f90a99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4f2505615389e15ac9f619e68f90a99">&#9670;&nbsp;</a></span>smtc_modem_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void smtc_modem_init </td>
          <td>(</td>
          <td class="paramtype">void(*)(void)&#160;</td>
          <td class="paramname"><em>callback</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Init the soft modem and set the modem event chosen callback. </p>
<dl class="section remark"><dt>Remarks</dt><dd>The callback will be called each time an modem event is raised internally</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>the user event callback prototype </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ae45f68af8fe65e4aa47dedbb5f5fd7e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae45f68af8fe65e4aa47dedbb5f5fd7e1">&#9670;&nbsp;</a></span>smtc_modem_run_engine()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t smtc_modem_run_engine </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Run the modem engine. </p>
<dl class="section remark"><dt>Remarks</dt><dd>This function must be called in main loop. It returns an amount of ms after which the function must at least be called again</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>the time in ms after which the function must at least be called again </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
